Skip to content

docs: Say what correct can and can't repair - #102

Draft
BenWestgate wants to merge 1 commit into
reviewability-v1from
claude/new-issue-fixes-fvhbl3-89
Draft

BenWestgate wants to merge 1 commit into
reviewability-v1from
claude/new-issue-fixes-fvhbl3-89

Conversation

@BenWestgate

Copy link
Copy Markdown
Owner

Requested by Ben · project thread

Before: the user guide gave correct one paragraph, and its limits were only in the developer API guide.

After: a "What correct can repair" section in the user guide lists what one string survives, what it doesn't, when to add --bytes 32, and why filling exactly 13 unreadable characters needs YES.

How: each limit was measured by damaging BIP-93 test vectors (48, 74 and 127 characters) and running the CLI's correction search, 2 to 4 trials per case, on #57's branch, with the 48-character cases repeated on reviewability-v1. Two items from the issue's starting list didn't hold and are left out: 2 missing plus 2 extra worked in only half the trials within ten seconds, and 3 missing plus 1 extra and two wrong groups never did. Script and results: limits.py and results-pr57-branch.txt in the project's correct-limits folder.

Docs only. Closes #89

🤖 Generated with Claude Code

https://claude.ai/code/session_015CuLXqAvAovfoVcUmmogwa


Generated by Claude Code

A tester called correction a black box: the user guide gave it one
paragraph and the limits were only in the developer API guide. List
what one string can survive and what it can't, plus the 13-fill case
that the YES prompt guards.

Each limit was checked by damaging BIP-93 test vectors and running the
correction search, 2 to 4 trials per case.

Closes #89

Claude-Session: https://claude.ai/code/session_015CuLXqAvAovfoVcUmmogwa
@BenWestgate BenWestgate self-assigned this Oct 1, 2026
@BenWestgate
BenWestgate marked this pull request as ready for review October 2, 2026 02:25
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@BenWestgate BenWestgate left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI-generated review (Codex), posted at the maintainer's request.

ACK 4a0b18b. The capability documentation matches the implemented correction behavior.

@BenWestgate BenWestgate added area: correction Correction engine and correction UX. documentation Improvements or additions to documentation gate: adversarial review Resolve, merge, or explicitly defer before the next full adversarial review. labels Oct 4, 2026

Copy link
Copy Markdown
Owner Author

V1 disposition (Codex, 2026-10-04): defer this post-audit correction-capability documentation from the v1 candidate.

The docs have a current-head Codex ACK and are useful, but they document follow-up field testing rather than closing a validated finding from the supplied adversarial reviews. The v1 user-facing audit fixes already include the reviewed mixed-case correction behavior and the length-specific recovery guidance. Keep #102 open for post-v1 so the frozen review candidate stops accumulating late documentation scope.

Human authorship/review remains required when integrated.

@BenWestgate
BenWestgate marked this pull request as draft October 4, 2026 19:18
@BenWestgate BenWestgate removed the gate: adversarial review Resolve, merge, or explicitly defer before the next full adversarial review. label Oct 4, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: correction Correction engine and correction UX. documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants